/*-
 * Copyright (c) 2006, 2007 FTS Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the FTS Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      DocumentHelper.hpp
 *
 * $FTS$
 */
#ifndef _DOCUMENT_HELPER_HPP__
#define _DOCUMENT_HELPER_HPP__ 1

namespace FTSS // FullTextSearchSystem
{

/**
  @class DocumentHelper DocumentHelper.hpp <DocumentHelper.hpp>
  @brief Helps to create document object from text stream
*/
class DocumentHelper
{
private:
	/** Index of zones        */
	STLW::vector<UINT_32>   vZone;
	/** Index of term offsets */
	STLW::vector<UINT_32>   vIndex;
	/** Terms                 */
	STLW::string            sData;
public:
	inline void StartZone() { vZone.push_back(sData.size()); }

	/**
	  @brief Store term in document
	  @param sTerm - term to store
	  @param iTermLength - term length
	*/
	inline void PushTerm(CCHAR_P * sTerm, const UINT_32 & iTermLength)
	{
		vIndex.push_back(sData.size());
		sData.append(sTerm, iTermLength);
	}

	inline void StopZone();

	/**
	  @brief Clear document data
	*/
	inline void Clear()
	{
		vIndex.clear();
		sData.erase();
	}

	/**
	  @brief Clear document data
	  @return index of document
	*/
	inline UINT_32 * GetIndex() { return &vIndex[0]; }

	/**
	  @brief Clear document data
	  @return pointer to all terms of document
	*/
	inline CCHAR_P GetTerms() { return sData.c_str(); }
};

} // namespace FTSS
#endif // _DOCUMENT_STORAGE_HPP__
// End.
